home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr38 / kawsol11.zip / KAWSOL.DOC < prev    next >
Text File  |  1995-04-18  |  17KB  |  407 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                       CorpSoft BBS (815) 886-9388                           ║
  4. ║                         3 Nodes - USR 28.8  v.34                            ║
  5. ║                                                                             ║
  6. ║                           KINGS ARE WILD SOLITAIRE                          ║
  7. ║                                    v1.1                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║           Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,          ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1995                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20.  
  21. Kings Are Wild is released as SHAREWARE. You are granted a limited license 
  22. to evaluate the program. Try it out, if you continue to use it for more than 
  23. 30 days you are required to register the program.
  24.  
  25. To register the program send $14.95 along with your name and BBS name
  26. to: Robert Neal, 317 Hickory Avenue, Romeoville, IL 60441. See the file
  27. MAILER.TXT for additonal pricing information and special discounts
  28. available. You may also register ONLINE with Visa or MasterCard by
  29. calling the support BBS at (815) 886-9388. Simply type CHARGE at the menu.
  30.  
  31. Once you register Kings Are Wild, you will be given your own unique 
  32. registration number. The BBS name supplied with payment will be the name 
  33. used to create your unique registration number.
  34.  
  35. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  36. WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  37. LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  38. PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND
  39. PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL
  40. DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  41.  
  42.  
  43. *PROGRAM DESCRIPTION*
  44.  
  45. Kings Are Wild is a online game which uses 2 decks of cards, one which
  46. creates a point grid and a second which is used as the playing deck. The 
  47. object is to remove all 20 cards from the point grid. This is done by
  48. matching the value of the Deck Card with either 1 or 2 cards in the
  49. point grid. The result is a quick game which is fun and at times can be 
  50. aggravating!
  51.  
  52. Kings Are Wild keeps track of dual scoreboards, one ranking each player 
  53. on their overall monthly score and a second ranking the top 10 Kings Are 
  54. Wild scores for the month. Kings Are Wild will automatically reset the 
  55. scoreboard at the start of each month, requiring no sysop maintenance 
  56. after initial set-up.
  57.  
  58.  
  59. *PROGRAM FEATURES*
  60.  
  61.   -  Easy to install and requires no maintenance.
  62.   -  Ansi colors and display.
  63.   -  Terminates cleanly through exit code even on runtime error.
  64.   -  Automatically creates a top score listing suitable for inclusion
  65.      as a text/bulletin file for display within your BBS. Both an
  66.      ANSI and ASCII file is created.
  67.   -  Detects loss of carrier.
  68.   -  Operates in local mode (either direct from BBS or from command line).
  69.   -  Sysop function keys to return to the board, chat mode, user stats,
  70.      increase/decrease time, etc.
  71.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS,
  72.      Ultra BBS, Telegard, TriTel and Remote Access.
  73.   -  Support for baud rates up to 115,200
  74.   -  Support for COM1-15. Optional command line for non-standard IRQ's.
  75.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  76.   -  Support Fossil Drivers. A Fossil driver is not required to use the
  77.      program.
  78.   -  Fully Multi-Node compatible.
  79.   -  Support for multi-port digiboards, for use with PCBoard /M.
  80.   -  Yearly scoreboard with rolling 12 month top scores
  81.   -  Optional "adopted by" banner to acknowledge users who contribute
  82.      towards registration of the game
  83.   -  Local play option to evaluate the program
  84.  
  85. As an encouragement to register Kings Are Wild, the following options are 
  86. not available until registered:
  87.     
  88.     - Games are limited to 3 per day
  89.     - Make up games is disabled
  90.  
  91. All other aspects of operation are fully functional. 
  92.  
  93.  
  94.  
  95. *FIRST TIME OPERATIONS*
  96.  
  97. Simply create a directory for Kings Are Wild and copy all files distributed
  98. with Kings Are Wild to this directory. Additional data files will automatically
  99. be created the first time Kings Are Wild is run.
  100.  
  101.  
  102. CONFIGURING THE PROGRAM
  103. Use the program KAWCFG which is included with the distributed program to 
  104. edit the file KAWSOL.CFG. Below is the layout of this file:
  105.  
  106. C:\PCB\PCBOARD.SYS
  107. Corporate Headquarters
  108. Bob
  109. Neal
  110. 15
  111. 0
  112. 0
  113. NA
  114. 5
  115.  
  116. Line 1 = Full pathname of your door file. Formats supported by this
  117.      program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  118.               CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  119.               GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS. When using
  120.               USERINFO.DAT, DOOR.SYS  must be in the same
  121.               directory as USERINFO.DAT.
  122. Line 2 = BBS name
  123. Line 3 = Sysop First Name
  124. Line 4 = Sysop Last Name
  125. Line 5 = number of rounds per day that a player may play. I suggest
  126.         a daily limit of 5 to 10, but tailor to your own needs.
  127. Line 6 = Registration number. Leave as 0 if unregistered.
  128. Line 7 = This line is not used for this version.
  129. Line 8 = You can place the name of the user who helped pay for the
  130.         registration of the door. Several sysops have specified that
  131.         users have paid the reigstration fee for Kings Are Wild. You can
  132.         now place their name on this line and their name will be
  133.         proudly displayed at the end of the game so that others may
  134.         recognize their contribtion to the operation of your BBS.
  135.         Leave this blank or NA if you do not wish to use this
  136.         option.
  137. Line 9 = Maximum number of make up games per day. You can allow your
  138.         users to make up games lost because they were unable to 
  139.         call and play. Enter the number of GAMES (not days) you 
  140.         allow them to make up each day. 
  141.  
  142.  
  143.  
  144. *EXECUTING PROGRAM*
  145.  
  146. To execute the program, enter the filename followed by the config file
  147. name (ie KAWSOL KAWSOL.CFG). If you are running the program from the
  148. command line, you may optionally enter KAWSOL LOCAL. The only problem
  149. with this is the default user name sysop is used instead of the name on
  150. your board. This is good for testing the game before putting it on your
  151. system, but you should once play begins, execute the program locally
  152. from your BBS or consistantly run the game from the command line when
  153. you play.
  154.  
  155. You may also specify a non-standard IRQ. Put the IRQ number after the
  156. .CFG on the command line. For example: KAWSOL KAWSOL.CFG /5. This
  157. example tells the program to use IRQ 5 instead of the standard IRQ.
  158.  
  159. You may also use the procedure above and create a variable IRQ so that
  160. you can pass the IRQ setting as: KAWSOL KAWSOL.CFG /%IRQ%
  161.  
  162. Some users may have had conflicts when using non-standard IRQ's on
  163. Novell/Netware systems. Novell seems to use the "/" character for
  164. parameter passing. You may not optionally use the "*" character instead
  165. of the "/", for example KAWSOL KAWSOL.CFG *%IRQ% is valid. Both "*" and
  166. "/" will work.
  167.  
  168.  
  169. *AUTOMATIC MAINTENANCE*
  170.  
  171. The program will automatically during the first play of each new month
  172. reset it's user file and top score listing. The previous months
  173. scoreboard will be renamed to KAWSOL.OLD and KAWSOLG.OLD. This can then 
  174. be included as a text file to display the previous months winners.
  175.  
  176. You should be aware of this so if you are starting a new game for the
  177. first time towards the end of the month, the game will automatically perform
  178. the maintenace come the first of the month.
  179.  
  180. As an option, you may pass the parameter "NEW" on the command line, for 
  181. example KAWSOL NEW. This will reset _all_ Kings Are Wild data files, including the
  182. overall high scorer information. 
  183.  
  184.  
  185.  
  186. *FOSSIL DRIVER*
  187.  
  188. Kings Are Wild includes support for FOSSIL drivers. This means that the
  189. program will work with Digiboard (for Wildcat M and PCBoard/M versions) 
  190. and other multi-port boards. To activate the Fossil driver support just 
  191. include /FD on the command line in your door batch file.
  192.  
  193.     For example: KAWSOL KAWSOL.CFG /FD
  194.  
  195. If no Fossil driver is available, Kings Are Wild will display a message
  196. indicating such and exit cleanly.
  197.  
  198.  
  199. This documentation will not go into the mechanics of how you set-up a door
  200. program on your BBS. It is assumed that you have a working knowledge of
  201. how to complete this task. It would be impossible for me to explain how
  202. to install a door for all BBS programs supported by Kings Are Wild.
  203.  
  204.  
  205. *SYSOP KEYS ACTIVE*
  206.  
  207. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  208.      written to DOOR.SYS and USERS.SYS
  209. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  210.      and/or written to DOOR.SYS and USERS.SYS
  211. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  212. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  213.      and/or written to DOOR.SYS and USERS.SYS
  214. F8    -  Returns the caller involuntarily to the BBS.
  215. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  216.      and/or written to DOOR.SYS and USERS.SYS
  217. F10   -  Activates SysOp CHAT mode within the DOOR.
  218. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  219. UP    -  Give the caller extra time while in the DOOR.  
  220. DN    -  Subtract time from the caller while in the DOOR. 
  221. HOME  -  HELP key for Status Line options.
  222. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  223. ALT-X -  PCBoard will exit after current caller logs off. Value is
  224.      passed to PCBoard. Not available on non-PCBoard systems.
  225.  
  226.  
  227. *MAKE UP DAYS OPTION (Registered version only)*
  228.  
  229. Many users will not participate in a game if they know they will be 
  230. unable to play each and every day. With the Make Up Days option, you can
  231. allow players to make up missed games (the number allowed per day is 
  232. defined by you). If you enter a 0, you will disable this option. Please 
  233. note that the value placed on this field in the .CFG file is the
  234. number of games, not days, you will allow the user to make up. 
  235.  
  236. As an example, if you allow 5 games per day, but allow 8 make up games, 
  237. the user will be able to play a maximum of 13 games on any single day. 
  238. If the user has played all games to date then the user will only be 
  239. allowed to play 5 games (as defined by you for number of plays per day).
  240.  
  241.  
  242. *ADOPTED BY OPTION (Registered version only)*
  243.  
  244. Many sysops are fortunate to have their users offer to register a door
  245. they enjoy playing. You can now give recognition to the user or users
  246. who assist in contributing to the registration of this program. Simply 
  247. enter their name(s) on the appropriate line in the configuration file.
  248.  
  249. When unregistered, the door will inform the user that they can adopt
  250. the door and refers them to ask you for details. You can give the
  251. user the registration form for them to send in if you'd like.
  252.  
  253. After the program is registered, each time a user quits the game a
  254. screen will be displayed informing other users who contributed towards
  255. the registration of the game. 
  256.  
  257. If you wish to disable this option, enter NA on the line in the 
  258. configuration file.
  259.  
  260.  
  261.  
  262. *FILES USED AND CREATED*
  263.  
  264. KAWSOL.EXE  - The program itself
  265. KAWSOL.DOC  - Documentation for the sysop to run Kings Are Wild
  266. KAWSOL.CFG  - Configuration file
  267. KAWOPEN.ANS - Opening introduction screen
  268. KAWSOL.HLP  - Help information display
  269.  
  270. The following files will be created by Kings Are Wild
  271.  
  272. KAWSOL.USR  - User file of current players
  273. KAWOPEN.ANS - Opening Screen
  274. KAWSOL.ASC  - Top 10 scores in ascii format can be used as a bulletin
  275. KAWSOL.ANS  - Top 10 scores in ANSI format
  276. KAWSOL.OLD  - Previous month top 10 ascii bulletin
  277. KAWSOLG.OLD - Previous month top 10 ANSI bulletin
  278. KAWSOL.DAT  - Contains information for scoreboard
  279. KAWSOL.HI   - Contains overall high score information
  280. KAWSOL.SCO  - Data file for scoreboard
  281. KAWSOL.TOT  - Data file for scoreboard
  282. KAWSOL.MSB  - Yearly scoreboard
  283. KAWSOL.MG   - Data file for yearly scoreboard
  284. KAWSOL.MP   - Data file for yearly scoreboard
  285.  
  286.  
  287. *TROUBLESHOOTING*
  288.  
  289. -  If you are running this Door on a 486 system and encounter an error
  290.    message "ERROR 6 - OVERFLOW ERROR" or you experience irratic Keyboard
  291.    Timeout messages, you may have to put the following in either your
  292.    AUTOEXEC.BAT file or in the batch file you use to call this program.
  293.  
  294.      SET NO87=ON
  295.  
  296.    If you are running on a 486 system with co-processor under DesqView, you
  297.    may alternately set Math Coprocessor in each window to YES.
  298.  
  299. -  If you encounter an ERROR 62 when the program first is loaded, this
  300.    will usually indicate that there is an error in your .CFG file. 
  301.    Recheck your .CFG file to verify the proper format (if you use the
  302.    KAWCFG program you should never encounter this error).
  303.  
  304. -  An ERROR 70 message means you more than likely do not have SHARE
  305.    loaded. This is typically only required for multi-node systems.
  306.  
  307.  
  308. *MULTI-NODE OPERATION*
  309.  
  310. If you are running a multi-node BBS, there are two ways which you      
  311. can set-up Kings are Wild.
  312.     
  313.     1. Create a seperate configuration file for each node.
  314.        The only difference between the configuration files would
  315.        be the location of your BBS drop file. 
  316.     
  317.     2. You can use one configuration file for all nodes by 
  318.        using an environment variable. Both PCBoard and Wildcat
  319.        provide these automatically when running a door program.
  320.        For PCBoard, the environment variables are PCBDIR and PCBDRIVE.
  321.        You can then place the following on the first line of your
  322.        configuration file:
  323.         %PCBDRIVE%%PCBDIR%\PCBOARD.SYS
  324.        For Wildcat systems, it uses the variable WCNODEID, you can 
  325.        place the following on the first line of your configuration
  326.        file: 
  327.         C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS
  328.  
  329.        If you are running other BBS software, you should be able to
  330.        create these variables so that you can run the program as
  331.        explained above.
  332.  
  333.        Other BBS systems may also use these variables by
  334.        including the following either in your BBS batch or 
  335.        AUTOEXEC.BAT file:
  336.  
  337.         SET PCBDRIVE=C:            <- Drive letter of your BBS files
  338.         SET PCBDIR=\BBS            <- Path of your BBS files
  339.  
  340.  
  341.  
  342.  
  343. *CONTACT ME FOR SUPPORT*
  344.  
  345. If you encounter any problems you may contact me at Corporate Headquarters
  346. BBS (815) 886-9388.
  347.  
  348. I can also be reached via the RIME network in the SYSOP, DOORS,
  349. SHAREWARE and BBS SOFTWARE conferences as well as the COMMON conference.
  350. I can also be reached via Internet e-mail at bob.neal@corpsoft.com. or
  351. via FIDO at 1:2235/886 (Bob Neal@1:2235/886).
  352.  
  353. If you have any suggestions for improvements for this program, please feel
  354. free to let me know. This game has included suggestions from users of my
  355. BBS during beta testing.
  356.  
  357.  
  358. *DISTRIBUTION SITES*
  359.  
  360.    As always you can find the latest version of Kings Are Wild available for
  361.    downloading from CorpSoft BBS.
  362.  
  363.    CorpSoft BBS   (815) 886-9388 (3 nodes with automatic ring-down,
  364.                   running USR 28800 v.everything)
  365.  
  366.    Also, I have a support conference on Salt Air BBS (home of PCBoard).
  367.    Join conference #71 (CorpSoft Support). I will always have the 
  368.    current version available for download on there as well as answer 
  369.    technical support question.
  370.  
  371. We also accept Visa and Mastercard. Register online with your Visa or
  372. Mastercard by calling CorpSoft BBS, simply type CHARGE at the main menu
  373. prompt.
  374.  
  375. User's with FIDO capabilities can FREQ the latest version of my software 
  376. from me at 1:2235/886. The magic names for my software are:
  377.     KING            Kings Are Wild
  378.     CARD            Card Sharks
  379.     BOWL            BBS Bowling Solitaire
  380.     GOLF            Links Golf
  381.     ZWORD           Z-Wordz
  382.     CORPSOFT        All my shareware releases
  383.  
  384. To further make it convenient for people to download my software, you can
  385. also login to my support BBS by enter CORPSOFT GUEST when prompted for 
  386. your name. You will not need to go through the new user information
  387. questionaire and will immediately be able to download my shareware. 
  388. Please note that if you wish to register online, you will need to
  389. set-up a user account so that your registration keys can be made available
  390. to you.
  391.  
  392.  
  393.  
  394. *VERSION HISTORY*
  395.  
  396. v1.1 -  Added routine to check if the current deck card can be played
  397.     in the point card grid. If not, the game will automatically 
  398.     end.
  399.      -  Fixed problem with number of make up games always being set
  400.     to 3
  401.      -  Fixed problem with the scores in the yearly scoreboard being
  402.     displayed in reverse of actual order
  403.  
  404. v1.0 - Initial Release
  405.  
  406.  
  407.